RecipientPersonUniversal Tabular View
| COCD_TP145202GB02 | |||||||||||
| IntendedRecipient |
This template class constrains the CDA IntendedRecipient class. A universal template for a recipient where information about the person and their organisation is required to be sent between systems. |
||||||||||
| Used by: | |||||||||||
| [1..1] [M] classCode (CS { CNE: RoleClass } ) { Fixed="ASSIGNED" } |
Model Attribute Description The HL7 attribute classCode describes this class as an assigned role. An assigned role is a type of agent in which, the player is a person employed by a scoping organisation. Implementation in XML Instance
|
||||||||||
| [0..1] addr (AD) |
Model Attribute Description The HL7 attribute addr provides an address associated with the role. This address is used to identify the address associated with the recipient; for example the GP practice address of the patient's GP. The HL7 attribute addr allows structured and unstructured addresses to be carried in an instance. Only structured addresses are recommended to be used. There are a number of structured forms of addresses. The three shown here are the recommended formats for organisation addresses, they are listed in no particular order. Implementation in XML Instance When the structured address in the style of PDS is used then it shall contain five XML elements streetAddressLine.
The first XML element streetAddressLine or second XML element streetAddressLine and the fourth XML element streetAddressLine are mandated to be populated.
or the address may use the fully structured address:
Alternatively the structured address may contain just a series of XML elements streetAddressLine populated in the correct order to render as a postal address with as much information as available included.
The XML element addr allows an XML attribute use, this should be used to further define the organisation address when required. Only the use values listed below are recommended to be used for organisation addresses.
The XML element useablePeriod of XML element addr can be used to indicate some of the following types of valid times:
|
||||||||||
| [1..*] [R] id (SET) |
Model Attribute Description The HL7 attribute id allows for the role to be identified using local identifiers. This may be done when there is a local requirement, when no local requirement exists the id should be nulled. Implementation in XML Instance The XML attribute nullFlavor of the XML element id should contain "NA" Where there is a local requirement for the role to be identified using a local identifier and an OID is available on the sending system then:
Where there is a local requirement for the role to be identified using a local identifier and no OID is available on the sending system then:
|
||||||||||
| [0..1] recipientRoleCode (CV { CNE:JobRoleName } ) |
Model Attribute Description
The HL7 attribute recipientRoleCode uses a code from the JobRoleName vocabulary to describe the role of the person who is the recipient. Implementation in XML Instance
|
||||||||||
| [0..*] telecom (SET<TEL>) |
Model Attribute Description The HL7 attribute telecom provides contact details for the person playing the role in the form of telephone numbers, fax numbers and email addresses. Implementation in XML Instance This XML element telecom should be populated as below: The XML attribute value of the XML element telecom should contain the telephone / fax number or an email address prefixed by the type of contact and a colon.
The XML attribute use of the XML element telecom may be used to give further information about the type of contact details contained in the XML attribute value. Only the use values listed below are recommended for the contact details associated with the role:
The XML element useablePeriod of XML element telecom may be used to indicate when the contact details given are valid, for example to indicate that a telephone number is only or office hours (9am to 5 pm). It can be used to indicate some of the following types of valid times:
|
||||||||||
| [1..1] [M] templateId (II) { Fixed="COCD_TP145202GB02#IntendedRecipient" } |
Model Attribute Description
The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use. Implementation in XML Instance The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
|
||||||||||
| [1..1] [M] assignedPerson (Person) |
A link to the person playing this role.
|
||||||||||
| [1..1] [M] representedOrganization (Organization) |
A link to the scoping organisation.
|
||||||||||
| Person |
This template class constrains the CDA Person class. A class which details the person who is the recipient. |
||||||||||
| Used by: IntendedRecipient | |||||||||||
| [1..1] [M] classCode (CS { CNE: EntityClass } ) { Fixed="PSN" } |
Model Attribute Description The HL7 attribute classCode describes this class as a person. Implementation in XML Instance
|
||||||||||
| [1..1] [M] determinerCode (CS { CNE: EntityDeterminer } ) { Fixed="INSTANCE" } |
Model Attribute Description The HL7 attribute determinerCode describes this class as an instance of a person. Implementation in XML Instance
|
||||||||||
| [1..1] [M] name (PN) |
Model Attribute Description The HL7 attribute name provides a name associated with the person who is the recipient. Implementation in XML Instance The Person Name Structured with optional Use and optional Valid Time flavour of the PN data type is the recommended format for the recipient's name. This information is carried in the XML element name as follows:
Additionally the XML attribute use of the XML element name should be used to indicate the type of name; the recommended codes to be used are listed below: Note some of the codes listed are NHS extensions, these are marked with an *
Additionally the XML element validTime of the XML element name may be used to indicate the time when the name is valid/was valid for the recipient, some uses are shown below:
|
||||||||||
| [1..1] [M] templateId (II) { Fixed="COCD_TP145202GB02#assignedPerson" } |
Model Attribute Description
The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use. Implementation in XML Instance The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
|
||||||||||
| Organization |
This template class constrains the CDA Organization class. This class details the organisation which scopes the role of the recipient (the organisation which employs the person who is the recipient). |
||||||||||
| Used by: IntendedRecipient | |||||||||||
| [1..1] [M] classCode (CS { CNE: EntityClass } ) { Fixed="ORG" } |
Model Attribute Description The HL7 attribute classCode describes this class as an organisation. Implementation in XML Instance
|
||||||||||
| [1..1] [M] determinerCode (CS { CNE: EntityDeterminer } ) { Fixed="INSTANCE" } |
Model Attribute Description The HL7 attribute determinerCode describes this class as an instance of an organisation. Implementation in XML Instance
|
||||||||||
| [1..1] [M] id (II) |
Model Attribute Description The HL7 attribute id uses an ODS code as an identifier that uniquely identifies the organisation which employs the recipient. The ODS code should identify the organisation at either the site level or organisation level. Where possible the organisation should be identified at the site level. ODS codes were formerly known as NACS codes. Implementation in XML Instance When ODS site code is used then the XML element id is populated in the following way:
When ODS organisation code is used then the XML element id is populated in the following way:
|
||||||||||
| [1..1] [M] name (ON) |
Model Attribute Description The HL7 attribute name uses the description of the organisation associated with the ODS code. Implementation in XML Instance
|
||||||||||
| [0..1] standardIndustryClassCode (CV { CNE:CDAOrganizationType } ) |
Model Attribute Description The HL7 attribute standardIndustryClassCode uses a code taken from the CDAOrganizationType vocabulary to indicate the type of organisation. Implementation in XML Instance
|
||||||||||
| [1..1] [M] templateId (II) { Fixed="COCD_TP145202GB02#representedOrganization" } |
Model Attribute Description Implementation in XML Instance The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
|